Bagaimana cara mendaftarkan API baru yang akan dimonitor?
Akses modul Web/API Monitoring → Web/API Status.
Dari halaman utama Web Status, klik tombol Add Web/API,
Selanjutnya akan muncul form untuk mengisi detail API yang akan dimonitor.
Isi data pada form tersebut dengan rincian sebagai berikut:
Jenis Isian | Keterangan |
---|
Name | Nama dari API yang akan dimonitor. |
Interval check | Rentang waktu diperiksanya status API secara berkala. |
User Group | Diisi dengan pilihan user group. Anda dapat memilih lebih dari 1 user group. Web/API yang telah didaftarkan untuk setiap User Group, tidak dapat diakses User Group lainnya (Kecuali pada User Group Default* dan User Group parent*). |
Probe | Pilihan probe yang akan bertugas mengambil data dari API yang dimonitor. Jika ingin menambahkan probe baru, klik Add New Probe. |
Tagging (opsional) | PLabel atau tanda untuk mengidentifikasi dan mengelompokkan data Web/API dengan lebih mudah. Pengguna dapat mengetik tagging yang ingin dibuat atau memilih tagging yang sudah pernah ditambahkan sebelumnya. |
URL/IP | Alamat URL atau alamat IP dari API yang akan dimonitor. Mendukung 2 protokol, yaitu HTTP dan HTTPS. |
Alert Threshold | Ambang batas response time yang ditentukan untuk API yang akan dimonitor (diisi dalam satuan milisecond) |
Selanjutnya, tambahkan request dan kondisi response yang diharapkan (opsional) dengan rincian sebagai berikut:
Jenis Isian | Keterangan |
---|
Request | Method | Request method yang menunjukkan tindakan yang diinginkan untuk dilakukan terhadap API yang akan dimonitor. |
Request headers | Request header yang dapat digunakan dalam HTTP request untuk memberikan informasi tentang konteks permintaan. |
Body | Data opsional yang terkait dengan request. |
Username | Username yang digunakan untuk mengakses API jika API tersebut memerlukan autentikasi. |
Password | Password yang digunakan untuk mengakses API jika API tersebut memerlukan autentikasi. |
Response Codition | Status Code | Kode status HTTP yang diharapkan keluar sebagai response dari API yang dimonitor. |
Match Header | Response header yang diharapkan keluar sebagai response dari API yang dimonitor. |
Match Body | Data di dalam response body yang diharapkan keluar sebagai response dari API yang dimonitor. |
Keterangan: Jika Status Code, Match Header, atau Match Body yang diinputkan tidak ada di dalam response, maka status API tersebut dianggap down karena tidak sesuai dengan kondisi yang diharapkan. |
Klik tombol Add Data untuk menambahkan API baru.
API berhasil ditambahkan. Selanjutnya apabila API yang ditambahkan dimonitor menggunakan hybrid probe, maka akan muncul kotak dialog yang berisi script untuk melakukan restart probe seperti berikut:
Apabila hybrid probe yang digunakan menggunakan linux atau docker, jalankan script menggunakan sudo. Apabila muncul pesan seperti berikut, pilih opsi Restart Probe
Sedangkan, jika hybrid probe yang digunakan menggunakan windows, jalankan Run as administrator pada aplikasi Windows PowerShell.
Lakukan paste pada Windows PowerShell, kemudian tekan enter untuk menjalankan script dan pilih opsi Restart Probe
Periksa kembali apakah API sudah berhasil ditambahkan melalui menu Web/API Status.